<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="namespaceipc.html">ipc</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport.html">transport</a></li><li class="navelem"><a class="el" href="namespaceipc_1_1transport_1_1sync__io.html">sync_io</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">Native_socket_stream</a></li><li class="navelem"><a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html">Impl</a></li><li class="navelem"><a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html">Snd_low_lvl_payload</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload Struct Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Data store representing a payload corresponding to exactly one attempted async write-op, albeit used if and only if we encounter would-block in <code>send_*()</code> or <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4b31da3a7ff63f307bd08e288c391556" title="Handler for the async-wait, via util::sync_io::Timer_event_emitter, of the auto-ping timer firing; if...">snd_on_ev_auto_ping_now_timer_fired()</a> or <code>*end_sending()</code> and have to queue (and therefore one-time-copy) data in <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1af9eb83b9afee25ba153a2ca066858d" title="Queue storing (at head) the currently in-progress async write-op of a Snd_low_lvl_payload; followed b...">m_snd_pending_payloads_q</a>.  
 <a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#details">More...</a></p>
<div class="dynheader">
Collaboration diagram for ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload__coll__graph.svg" width="287" height="227"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a2d3a01b00a000c3f40b3d580cd3b1c35"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35">Ptr</a> = boost::movelib::unique_ptr&lt; <a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html">Snd_low_lvl_payload</a> &gt;</td></tr>
<tr class="memdesc:a2d3a01b00a000c3f40b3d580cd3b1c35"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for <code>unique_ptr</code> to this.  <a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35">More...</a><br /></td></tr>
<tr class="separator:a2d3a01b00a000c3f40b3d580cd3b1c35"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a1896eff734a019cec47970cc081482e8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespaceipc_1_1transport.html#a7ee4551983d9df16ec16a3139bac50e8">Native_handle</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a1896eff734a019cec47970cc081482e8">m_hndl_or_null</a></td></tr>
<tr class="memdesc:a1896eff734a019cec47970cc081482e8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The native handle to transmit in the payload; <code>.null() == true</code> to transmit no such thing.  <a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a1896eff734a019cec47970cc081482e8">More...</a><br /></td></tr>
<tr class="separator:a1896eff734a019cec47970cc081482e8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd7b83c53f0bc04c6c74315f1bbe09d6"><td class="memItemLeft" align="right" valign="top">flow::util::Blob&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#abd7b83c53f0bc04c6c74315f1bbe09d6">m_blob</a></td></tr>
<tr class="memdesc:abd7b83c53f0bc04c6c74315f1bbe09d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">The buffer to transmit in the payload; <code>!m_blob.empty() == true</code>, period.  <a href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#abd7b83c53f0bc04c6c74315f1bbe09d6">More...</a><br /></td></tr>
<tr class="separator:abd7b83c53f0bc04c6c74315f1bbe09d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >Data store representing a payload corresponding to exactly one attempted async write-op, albeit used if and only if we encounter would-block in <code>send_*()</code> or <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a4b31da3a7ff63f307bd08e288c391556" title="Handler for the async-wait, via util::sync_io::Timer_event_emitter, of the auto-ping timer firing; if...">snd_on_ev_auto_ping_now_timer_fired()</a> or <code>*end_sending()</code> and have to queue (and therefore one-time-copy) data in <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl.html#a1af9eb83b9afee25ba153a2ca066858d" title="Queue storing (at head) the currently in-progress async write-op of a Snd_low_lvl_payload; followed b...">m_snd_pending_payloads_q</a>. </p>
<p >Note this does <em>not</em> represent an original user message given to <a class="el" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html#a9805f7625a1272af64295555f9a1a61b" title="Implements Native_handle_sender API per contract.">Native_socket_stream::send_native_handle()</a> but rather a low-level payload per the protocol described in the impl section of class doc header (payload 1, payload 2 if applicable). We store them in queue via <a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35" title="Short-hand for unique_ptr to this.">Ptr</a>. </p>

<p class="definition">Definition at line <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00609">609</a> of file <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html">native_socket_stream_impl.hpp</a>.</p>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a2d3a01b00a000c3f40b3d580cd3b1c35" name="a2d3a01b00a000c3f40b3d580cd3b1c35"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d3a01b00a000c3f40b3d580cd3b1c35">&#9670;&nbsp;</a></span>Ptr</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">using <a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html#a2d3a01b00a000c3f40b3d580cd3b1c35">ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload::Ptr</a> =  boost::movelib::unique_ptr&lt;<a class="el" href="structipc_1_1transport_1_1sync__io_1_1Native__socket__stream_1_1Impl_1_1Snd__low__lvl__payload.html">Snd_low_lvl_payload</a>&gt;</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Short-hand for <code>unique_ptr</code> to this. </p>

<p class="definition">Definition at line <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00614">614</a> of file <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html">native_socket_stream_impl.hpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abd7b83c53f0bc04c6c74315f1bbe09d6" name="abd7b83c53f0bc04c6c74315f1bbe09d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd7b83c53f0bc04c6c74315f1bbe09d6">&#9670;&nbsp;</a></span>m_blob</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">flow::util::Blob ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload::m_blob</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The buffer to transmit in the payload; <code>!m_blob.empty() == true</code>, period. </p>
<p >Note that this is the actual buffer and not a mere location/size of an existing blob somewhere. </p>

<p class="definition">Definition at line <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00625">625</a> of file <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html">native_socket_stream_impl.hpp</a>.</p>

</div>
</div>
<a id="a1896eff734a019cec47970cc081482e8" name="a1896eff734a019cec47970cc081482e8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1896eff734a019cec47970cc081482e8">&#9670;&nbsp;</a></span>m_hndl_or_null</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="namespaceipc_1_1transport.html#a7ee4551983d9df16ec16a3139bac50e8">Native_handle</a> ipc::transport::sync_io::Native_socket_stream::Impl::Snd_low_lvl_payload::m_hndl_or_null</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The native handle to transmit in the payload; <code>.null() == true</code> to transmit no such thing. </p>

<p class="definition">Definition at line <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html#l00619">619</a> of file <a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html">native_socket_stream_impl.hpp</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>transport/sync_io/detail/<a class="el" href="sync__io_2detail_2native__socket__stream__impl_8hpp_source.html">native_socket_stream_impl.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:27 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
